vcComponentFlowProxy

vcComponentFlowProxy gives information about components attempting to enter a flow proxy, and then routes components by testing the available capacity of connected behaviors.

See in: Overview

Module: vcBehaviors

Parent: vcFlow

Children -

Referenced by: vcRoutingRule.FlowProxy

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
ComponentSignal	vcComponentSignal	RW	Gets or sets the signal used for signaling what component has been transferred into proxy. See more This property and PortSignal should be used to determine what and where a component has entered the proxy. Can be None.
DynamicConnections	Boolean	RW	Gets or sets a value which defines if the connectors of proxy are dynamic. That is, connections will be established during a simulation by using a Python script or command.
InternalConnectorCount	Integer	R	Gets the number of connectors in proxy. See more An internal connector is always paired with an external connector, so this count will match the count for the proxy's external connectors.
PortSignal	vcIntegerSignal	RW	Gets or sets the signal used for signaling which connector a component used to enter proxy. The value is the index position of the connector in the proxy's list of connectors. Can be None.
RetainOffset	Boolean	RW	Gets or sets the value for retain offset.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
connectInternally	None	Integer index, vcConnector OR None connector	Connects an internal connector at a given index in proxy to a given connector. See more Parameters: index (Integer): Index of the internal connector. connector (vcConnector): The connector to connect to. Exceptions: IndexError: When index is out of range.
createConnector	vcConnector	None	Creates a new connector in proxy. This creates a pair of internal and external connectors. Returns the newly created vcConnector.
deleteConnector	None	Integer index	Deletes a connector at a given index from proxy. This deletes a pair of internal and external connectors. See more Parameters: index (Integer): Index of the internal connector. Exceptions: IndexError: When index is out of range.
getInternalConnector	vcConnector	Integer index	Returns an internal connector at a given index in proxy. See more Parameters: index (Integer): Index of the internal connector. Exceptions: IndexError: When index is out of range. Returns: vcConnector: The found connector.
resetConnectorPort	None	Integer index	Resets a connector at a given index in proxy, thereby disconnecting the connector from all of its connections. See more Parameters: index (Integer): Index of the internal connector. Exceptions: IndexError: When index is out of range.